All SiteZAP commands are executed by issuing a command to the SiteCam server. Commands will only be executed by the user currently in control of the camera. Control is then granted to users who wait in a queue to control the camera.
Note: As a site administrator, you can override user access to the camera by turning off access from the Admin Settings. This will remove any current users and prevent access to the camera. As an administrator, you will then be free to send as many commands to the camera as needed until access is re-activated.
Control Commands can be added to your Web page by using standard HTML. Review the source of this page to see the exact syntax. The SiteZAP Plug-in returns a <NO RESPONSE> reply, which is ignored by the browser. This allows the browser to continue accepting streaming video without changing the contents of the page that was selected.
Camera Movement
1.ptz move down and to the left
2.ptz move down
3.ptz move down and to the right
4.ptz move left
6.ptz move right
7.ptz move up and to the left
8.ptz move up
9.ptz move up and to the right
left.ptz move left
right.ptz move right
up.ptz move up
down.ptz move down
home.ptz move camera to home position
Lense Zoom
in.ptz Zoom in
out.ptz Zoom out
z0.ptz Set zoom position 0
z1.ptz Set zoom position 1
z2.ptz Set zoom position 2
z3.ptz Set zoom position 3
z4.ptz Set zoom position 4
z5.ptz Set zoom position 5
z6.ptz Set zoom position 6
z7.ptz Set zoom position 7
z8.ptz Set zoom position 8
Pre-defined Presets
p1.ptz goto preset 1
p2.ptz goto preset 2
p3.ptz goto preset 3
p4.ptz goto preset 4
p5.ptz goto preset 5
p6.ptz goto preset 6
setpreset.ptz?1 set preset 1 to current position
setpreset.ptz?2 set preset 2 to current position
setpreset.ptz?3 set preset 3 to current position
setpreset.ptz?4 set preset 4 to current position
setpreset.ptz?5 set preset 5 to current position
setpreset.ptz?6 set preset 6 to current position
Executing AppleScripts
AppleScripts that reside in the SiteCam:Scripts:SiteZAP: Folder can be executed remotely via HTML commands. Commands that end in an asterisk (*) cannot be executed via HTML, therefore, if there are commands you want private, append an * to the end of the command. SiteZAP ships with the PowerOn* and PowerOff* commands protected from outside access. To make those commands available in HTML, simply remove the asterisk and call them using the new name.
exec.ptz?Goto Random Location Execute the "Goto Random Location" AppleScript.
exec.ptz?Goto Random Preset Execute the "Goto Random Preset" AppleScript.
Your own custom AppleScripts can be embedded into any HTML page that the SiteZAP server has access to.
Status
The SiteZAP status window notifies each connected user when it their turn to take control of the camera, how many seconds remain in each turn, and what position in line the user is. There are two different types of methods of adding status to your html.
state.ptz - This is the default method of returning status information to the user. The state command returns one of 10 html files to the user, depending on which state the user is in.
InUseBusy.html |
The viewer is not in line and the line is full. SiteZAP is being controlled by another user.
|
InUseInline.html |
The viewer is in line to control the camera. SiteZAP is being controlled by someone else.
|
InUseOut.html |
The viewer is not in line. SiteZAP is being controlled by someone else.
|
InUseUser.html |
SiteZAP is in use by the viewer.
|
Offline.html |
SiteZAP application is not running, or the administer has turned off access.
|
SiteZAPFree.html |
The viewer is not in line, and no one is using the camera or in line to control the camera.
|
WaitingBusy.html |
The viewer is not in line, and the line is full. SiteZAP is waiting for the current user to control the camera.
|
WaitingInline.html |
The viewer is in line to control the camera. SiteZAP is waiting for the current user to control the camera.
|
WaitingOut.html |
The viewer is not in line. SiteZAP is waiting for the current user to control the camera.
|
WaitingUser.html |
Its the viewer's turn to control the camera. The user must click on one of the control buttons or lose his/her turn.
|
The html files above usually have a META REFRESH tag in them that causes the browser to refresh the state. This is done by specifying:
<meta http-equiv="refresh" content="6; URL=http://<!--HOST_NAME-->/status/state.ptz">
Notes:
- The content=6; means to refresh the page every 6 seconds. This can be changed to any value depending on your preferences.
- The <!--HOST_NAME--> will automatically be changed to the IP address of the machine by the SiteCam server.
- /status/state.ptz means that the 10 status files must be located in the folder Status in the root directory (WebDocs) folder. But a different path can be used to create multiple SiteZAP status formats.
- status.ptz - sends a stream of pan tilt data from the template file ptz_status. Use as a FRAME SRC for the status bar.
This is not supported by Microsoft's Internet Explorer, so its use should be avoided in public Web sites. It also requires a full network connection for each person viewing the status stream. Therefore, if the number of connections are limited, you should use the Meta Refresh method of returning user status.
Administration
pi_admin.ptz
The admin page lets you view and modify SiteZAP Plug-in features.
Items that can be controlled include:
- Whether public access is On or Off.
- The amount of time that a user can spend controlling the camera.
- The amount the camera moves with each Move command.
- The amount that the camera Zooms when a Zoom In or Zoom Out command is issued.
- Where the camera should go after its been idle for a period of time.
You can also set presets via the Web with the appropriate admin password.
|